<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>blmc_drivers: blmc_drivers::AnalogSensor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">blmc_drivers
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classblmc__drivers_1_1AnalogSensor.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classblmc__drivers_1_1AnalogSensor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">blmc_drivers::AnalogSensor Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classblmc__drivers_1_1AnalogSensor.html" title="AnalogSensor class is the implementation of the above interface. ">AnalogSensor</a> class is the implementation of the above interface.  
 <a href="classblmc__drivers_1_1AnalogSensor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="analog__sensor_8hpp_source.html">analog_sensor.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for blmc_drivers::AnalogSensor:</div>
<div class="dyncontent">
<div class="center"><img src="classblmc__drivers_1_1AnalogSensor__inherit__graph.png" border="0" usemap="#blmc__drivers_1_1AnalogSensor_inherit__map" alt="Inheritance graph"/></div>
<map name="blmc__drivers_1_1AnalogSensor_inherit__map" id="blmc__drivers_1_1AnalogSensor_inherit__map">
<area shape="rect" id="node2" href="classblmc__drivers_1_1AnalogSensorInterface.html" title="AnalogSensorInterface class is a simple abstract interface for using blmc analog measurements. " alt="" coords="11,80,196,121"/>
<area shape="rect" id="node3" href="classblmc__drivers_1_1DeviceInterface.html" title="this class exists purely for logical reasons, it does not in itself implement anything. " alt="" coords="5,5,201,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for blmc_drivers::AnalogSensor:</div>
<div class="dyncontent">
<div class="center"><img src="classblmc__drivers_1_1AnalogSensor__coll__graph.png" border="0" usemap="#blmc__drivers_1_1AnalogSensor_coll__map" alt="Collaboration graph"/></div>
<map name="blmc__drivers_1_1AnalogSensor_coll__map" id="blmc__drivers_1_1AnalogSensor_coll__map">
<area shape="rect" id="node2" href="classblmc__drivers_1_1AnalogSensorInterface.html" title="AnalogSensorInterface class is a simple abstract interface for using blmc analog measurements. " alt="" coords="11,80,196,121"/>
<area shape="rect" id="node3" href="classblmc__drivers_1_1DeviceInterface.html" title="this class exists purely for logical reasons, it does not in itself implement anything. " alt="" coords="5,5,201,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3107ba6bba78d46e126ffc74c88f5a69"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblmc__drivers_1_1AnalogSensor.html#a3107ba6bba78d46e126ffc74c88f5a69">AnalogSensor</a> (std::shared_ptr&lt; <a class="el" href="classblmc__drivers_1_1MotorBoardInterface.html">MotorBoardInterface</a> &gt; board, bool sensor_id)</td></tr>
<tr class="memdesc:a3107ba6bba78d46e126ffc74c88f5a69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classblmc__drivers_1_1AnalogSensor.html" title="AnalogSensor class is the implementation of the above interface. ">AnalogSensor</a> object.  <a href="#a3107ba6bba78d46e126ffc74c88f5a69">More...</a><br /></td></tr>
<tr class="separator:a3107ba6bba78d46e126ffc74c88f5a69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6edd73f6625a940a05042bef9a4c264"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; const <a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html#a4e4a853aa044b7d3afbaa3fe20477602">ScalarTimeseries</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblmc__drivers_1_1AnalogSensor.html#ae6edd73f6625a940a05042bef9a4c264">get_measurement</a> () const </td></tr>
<tr class="memdesc:ae6edd73f6625a940a05042bef9a4c264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the measurement object which is the list of time stamped data.  <a href="#ae6edd73f6625a940a05042bef9a4c264">More...</a><br /></td></tr>
<tr class="separator:ae6edd73f6625a940a05042bef9a4c264"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classblmc__drivers_1_1AnalogSensorInterface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classblmc__drivers_1_1AnalogSensorInterface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html">blmc_drivers::AnalogSensorInterface</a></td></tr>
<tr class="memitem:a809cd9b86ae1cb9119a2ad025163afa9 inherit pub_methods_classblmc__drivers_1_1AnalogSensorInterface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html#a809cd9b86ae1cb9119a2ad025163afa9">~AnalogSensorInterface</a> ()</td></tr>
<tr class="memdesc:a809cd9b86ae1cb9119a2ad025163afa9 inherit pub_methods_classblmc__drivers_1_1AnalogSensorInterface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the <a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html" title="AnalogSensorInterface class is a simple abstract interface for using blmc analog measurements. ">AnalogSensorInterface</a> object.  <a href="#a809cd9b86ae1cb9119a2ad025163afa9">More...</a><br /></td></tr>
<tr class="separator:a809cd9b86ae1cb9119a2ad025163afa9 inherit pub_methods_classblmc__drivers_1_1AnalogSensorInterface"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classblmc__drivers_1_1AnalogSensorInterface"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classblmc__drivers_1_1AnalogSensorInterface')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html">blmc_drivers::AnalogSensorInterface</a></td></tr>
<tr class="memitem:a4e4a853aa044b7d3afbaa3fe20477602 inherit pub_types_classblmc__drivers_1_1AnalogSensorInterface"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e4a853aa044b7d3afbaa3fe20477602"></a>
typedef real_time_tools::ThreadsafeTimeseries&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html#a4e4a853aa044b7d3afbaa3fe20477602">ScalarTimeseries</a></td></tr>
<tr class="memdesc:a4e4a853aa044b7d3afbaa3fe20477602 inherit pub_types_classblmc__drivers_1_1AnalogSensorInterface"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is just a short cut for the time series types. <br /></td></tr>
<tr class="separator:a4e4a853aa044b7d3afbaa3fe20477602 inherit pub_types_classblmc__drivers_1_1AnalogSensorInterface"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classblmc__drivers_1_1AnalogSensor.html" title="AnalogSensor class is the implementation of the above interface. ">AnalogSensor</a> class is the implementation of the above interface. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3107ba6bba78d46e126ffc74c88f5a69"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">blmc_drivers::AnalogSensor::AnalogSensor </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classblmc__drivers_1_1MotorBoardInterface.html">MotorBoardInterface</a> &gt;&#160;</td>
          <td class="paramname"><em>board</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>sensor_id</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct a new <a class="el" href="classblmc__drivers_1_1AnalogSensor.html" title="AnalogSensor class is the implementation of the above interface. ">AnalogSensor</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">board</td><td>is a motor board which gives access to the motor sensors (position, velocity, current, etc) and to the motor cotrols. </td></tr>
    <tr><td class="paramname">sensor_id</td><td>is the id of the sensor on the control board </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae6edd73f6625a940a05042bef9a4c264"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt; const <a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html#a4e4a853aa044b7d3afbaa3fe20477602">AnalogSensorInterface::ScalarTimeseries</a> &gt; blmc_drivers::AnalogSensor::get_measurement </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the measurement object which is the list of time stamped data. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;const ScalarTimeseries&gt; which is a pointer to the a list of time stamped data </dd></dl>

<p>Implements <a class="el" href="classblmc__drivers_1_1AnalogSensorInterface.html#afd694f79c9fec5a35984d468f59f315c">blmc_drivers::AnalogSensorInterface</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/workspace/software/workspace/src/catkin/hardware/blmc_drivers/include/blmc_drivers/devices/<a class="el" href="analog__sensor_8hpp_source.html">analog_sensor.hpp</a></li>
<li>/workspace/software/workspace/src/catkin/hardware/blmc_drivers/src/<a class="el" href="analog__sensors_8cpp.html">analog_sensors.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceblmc__drivers.html">blmc_drivers</a></li><li class="navelem"><a class="el" href="classblmc__drivers_1_1AnalogSensor.html">AnalogSensor</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
